/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.common;

import java.util.Date;
import java.util.Set;

import lombok.Data;
import lombok.NoArgsConstructor;

import org.hisp.dhis.analytics.SortOrder;
import org.hisp.dhis.program.ProgramStatus;

/**
 * @author Jan Bernitt
 */
@Data
@NoArgsConstructor
public class EnrollmentAnalyticsQueryCriteria extends RequestTypeAware
{
    private Date startDate;

    private Date endDate;

    /**
     * Date interval for enrollment date;
     */
    private String enrollmentDate;

    /**
     * Time interval for incident date;
     */
    private String incidentDate;

    /**
     * Time interval for last updated date;
     */
    private String lastUpdated;

    private String timeField;

    private Set<String> dimension;

    private Set<String> filter;

    /**
     * This parameter selects the headers to be returned as part of the
     * response. The implementation for this Set will be LinkedHashSet as the
     * ordering is important.
     */
    private Set<String> headers;

    private OrganisationUnitSelectionMode ouMode;

    private Set<String> asc;

    private Set<String> desc;

    private boolean skipMeta;

    private boolean skipData;

    private boolean completedOnly;

    private boolean hierarchyMeta;

    private boolean coordinatesOnly;

    private boolean includeMetadataDetails;

    private IdScheme dataIdScheme;

    private Set<ProgramStatus> programStatus;

    private Integer page;

    private Integer pageSize;

    private boolean paging;

    private DisplayProperty displayProperty;

    private Date relativePeriodDate;

    private String userOrgUnit;

    private String coordinateField;

    private SortOrder sortOrder;

    private boolean totalPages;
}
